Skip to content

Danny/sdk docs polish #16441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Apr 24, 2025
Merged

Danny/sdk docs polish #16441

merged 3 commits into from
Apr 24, 2025

Conversation

@dannyroosevelt
Copy link
Collaborator

@dannyroosevelt dannyroosevelt commented Apr 24, 2025 •
edited by coderabbitai bot
Loading

WHY

Summary by CodeRabbit

  • New Features
    • Added enhanced cross-origin support for Connect demo pages by setting the Cross-Origin-Opener-Policy header.
  • Bug Fixes
    • Improved handling of missing or unusual origin headers for account-related requests in the Connect demo, ensuring more robust token and host detection.
  • Documentation
    • Updated internal documentation to reflect new header configurations and improved request handling.

@vercel
Copy link

vercel bot commented Apr 24, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 🛑 Canceled (Inspect) Apr 24, 2025 7:43pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
pipedream-docs ⬜️ Ignored (Inspect) Apr 24, 2025 7:43pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Apr 24, 2025 7:43pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 24, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

This change introduces enhanced cross-origin header handling for the Connect demo pages and API endpoints. In the Next.js configuration, a new asynchronous headers function sets the Cross-Origin-Opener-Policy header for all /connect/:path* routes. Within the API utilities, the logic for determining the effective host in generateRequestToken is made more robust, including special handling for account-related endpoints and improved error handling. Additionally, the setCorsHeaders function now sets the Cross-Origin-Opener-Policy header to facilitate secure popup communication, which is essential for OAuth flows.

Changes

File(s) Change Summary
docs-v2/next.config.mjs Added an async headers function to set Cross-Origin-Opener-Policy: same-origin-allow-popups for /connect/:path* routes.
docs-v2/pages/api/demo-connect/utils.js Enhanced generateRequestToken to more robustly determine effectiveHost, including special handling for /accounts/ endpoints and improved error handling. Updated setCorsHeaders to set Cross-Origin-Opener-Policy header.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant NextJS_Server
    participant API_Utils

    Client->>NextJS_Server: Request to /connect/:path*
    NextJS_Server-->>Client: Responds with Cross-Origin-Opener-Policy header

    Client->>API_Utils: API request (with headers)
    API_Utils->>API_Utils: generateRequestToken (determine effectiveHost)
    API_Utils->>API_Utils: setCorsHeaders (set CORS and Cross-Origin-Opener-Policy)
    API_Utils-->>Client: API response with updated headers
Loading

Possibly related PRs

  • PipedreamHQ/pipedream#16420: Both PRs modify the same file docs-v2/pages/api/demo-connect/utils.js and involve changes related to request token handling and headers, indicating a direct connection in enhancing request validation and CORS header management.

Poem

🐇
Across the code, new headers fly,
To help our popups reach the sky.
With tokens parsed and hosts in sight,
OAuth flows now work just right.
Cross-origin bunnies leap with cheer—
Secure connections, far and near!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs-v2/pages/api/demo-connect/utils.js

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

docs-v2/next.config.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea8d185 and f64b883.

📒 Files selected for processing (2)
  • docs-v2/next.config.mjs (1 hunks)
  • docs-v2/pages/api/demo-connect/utils.js (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dannyroosevelt dannyroosevelt merged commit 0070d5f into master Apr 24, 2025
5 of 6 checks passed
@dannyroosevelt dannyroosevelt deleted the danny/sdk-docs-polish branch April 24, 2025 19:43
@vercel vercel bot temporarily deployed to Preview – docs-v2 April 24, 2025 19:43 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dannyroosevelt